This is the documentation for the Realbasic Plugins from Monkeybreadsoftware.de. You find these plugins and the newest version of this document at http://www.monkeybreadsoftware.de/realbasic inside the plugins section.
This help was last updated on Freitag, 6. September 2002 and covers 2136 items: 126 classes, 2 controls and 583 global functions.
| The list of the themes | Global methods by category | Global methods by name | The list of the classes | The list of the controls |
class FBCSearchSession | ||||
| class, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
A Find by Content Search Session. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
AddAllVolumes(includeRemote as boolean) as boolean | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Adds all volumes to this search session. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
AddVolume(volume as folderitem) as boolean | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Adds the given volume to this search session. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
Clone as FBCSearchSession | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Clones the search session. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
HitCount as integer | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: -> 0. | ||
|
Function:
Returns the number of hits in the search session. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
HitDocument(HitNumber as integer) as folderitem | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: -> nil. | ||
|
Function:
Returns the file whose index is HitNumber. | ||||
|
Notes:
HitNumber goes from 0 to HitCount-1. Find by Content seems not to work correctly on Mac OS X. | ||||
HitMatchedWords(index as integer) as string | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: -> "". | ||
|
Function:
Returns a string with a list of matched words for the hit in the search session whose index is index. | ||||
|
Notes:
This list of words illustrates why the hit was returned. The list is seperated using ", ". Index goes from 0 to HitCount-1. Find by Content seems not to work correctly on Mac OS X. | ||||
HitScore(HitNumber as integer) as double | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: -> 0. | ||
|
Function:
Returns relevance score assigned to the hit in the search session whose index is HitNumber. | ||||
|
Notes:
The score is a direct measure of the document's relevance to the search criteria in the context of this particular search. Scores are normalized to the range 0.0 - 1.0, and the most relevant hit from every search always has a score of 1.0. HitNumber goes from 0 to HitCount-1. Find by Content seems not to work correctly on Mac OS X. | ||||
HitTopicWords(HitNumber as integer) as string | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: -> "". | ||
|
Function:
Returns a list of topical words for the hit in the search session whose index is HitNumber. | ||||
|
Notes:
This list of words provides a clue about "what the document is about." The list is seperated using ", ". HitNumber goes from 0 to HitCount-1. Find by Content seems not to work correctly on Mac OS X. | ||||
Query(text as string) as boolean | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Runs a search for the given text. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
Query(text as string, max as integer) as boolean | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Runs a search for the given text. | ||||
|
Notes:
Max is the maximum count of files to find. Find by Content seems not to work correctly on Mac OS X. | ||||
Query(text as string, max as integer,folders() as folderitem) as boolean | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Runs a search for the given text. | ||||
|
Notes:
The folders are added to the volumes in the search session. Max is the maximum count of files to find. Find by Content seems not to work correctly on Mac OS X. | ||||
RemoveVolume(volume as folderitem) as boolean | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Removes the given volume to this search session. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
VolumeCount as integer | ||||
| method, FindbyContent | Mo, 15. Jul 2002 | |||
| Mac OS Classic: Works. | Mac OS Carbon: Seems not to work correctly. | Windows: does nothing. | ||
|
Function:
Returns how many volumes are inside the search session. | ||||
|
Notes:
Find by Content seems not to work correctly on Mac OS X. | ||||
Written 2002 by Christian Schmitz. Feel free to ask or report mistakes to realbasic@macsw.de.
Thanks.